Skip to content

Update contributors guide#789

Merged
edwardchalstrey1 merged 13 commits intomasterfrom
fix/786
Mar 4, 2026
Merged

Update contributors guide#789
edwardchalstrey1 merged 13 commits intomasterfrom
fix/786

Conversation

@edwardchalstrey1
Copy link
Member

@edwardchalstrey1 edwardchalstrey1 commented Feb 27, 2026

Issues closed by this PR

Description of the changes in this PR

  • This PR adds a code of conduct, note for new contributors and policy on AI-assisted contributions to the contributors guide
  • Also updates the index page of the docs linking to this clearly, and the README

How to review this PR

  • Click the generated readthedocs link in the CI
  • Look at the new sections on the contributors page
  • Check the index/readme and whether the policies are easy enough to find

Copy link
Member

@tturocy tturocy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few nitpicks and devils-advocate thoughts.

- **You are responsible for your contributions.** If you use generative AI to help you write code or documentation, you must fully understand the output. You should be able to explain the changes and why they are the correct approach for the project.
- **Add value.** Simply taking a prompt, feeding it to an AI, and posting the result as a contribution is not helpful. We expect you to use your own expertise to verify, test, and refine any AI-generated content. To preserve precious developer time, we reserve the right to rigorously reject low-value contributions, whether AI-generated or not.
- **No AI-generated comments.** Please do not post output from Large Language Models (LLMs) or similar tools as comments on GitHub issues or pull requests. Such comments are often generic and do not add to the discussion.
- **No bots.** It is strictly forbidden to use automated tooling, such as bots or agents, to post AI-generated content to issues or pull requests.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again devil's advocate: I could imagine hypothetically that we might have some automated tools which do something on PRs, and given that "AI" isn't strictly speaking well defined, we might fall foul of our own stated guideline. Do we want to add something like "without the advance approval of the core development team"?

@edwardchalstrey1 edwardchalstrey1 requested a review from tturocy March 2, 2026 10:34
tturocy and others added 3 commits March 3, 2026 16:38
Co-authored-by: Ed Chalstrey <edwardchalstrey@gmail.com>
Co-authored-by: Ed Chalstrey <edwardchalstrey@gmail.com>
@edwardchalstrey1 edwardchalstrey1 merged commit fbcbcbe into master Mar 4, 2026
26 checks passed
@edwardchalstrey1 edwardchalstrey1 deleted the fix/786 branch March 4, 2026 09:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants